// Copyright (c) 2008-2010, Arne Claus
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification, are permitted provided that the 
// following conditions are met:
//
// - Redistributions of source code must retain the above copyright notice, this list of conditions and the following 
//   disclaimer.
// - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following 
//   disclaimer in the documentation and/or other materials provided with the distribution.
// - Neither the name Arne Claus nor the names of any contributors may be used to endorse or promote products
//   derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, 
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE 
// USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#ifndef __INCLUDED_CBL_REFERENCEPTR_H__
#define __INCLUDED_CBL_REFERENCEPTR_H__

#include "CBL_Defines.h"
#include "CBL_Memory.h"
#include <cstdlib>

CB_NAMESPACE_START

//! \note	Provides memory management on copy and delete, meaning the wrapped object will be deleted
//!			if there is no referenceptr left handling the object.
//!			Note: This pointer is only ment to be used in certain "fire and forget", external or data 
//!			layout relevant scenarios. You should consider using CResourcePtr over this class.

// -------------------------------------------------------------------------------------------------
//	CReferencePtr
// -------------------------------------------------------------------------------------------------

template <typename TType>
class CReferencePtr
{
public:
	
	CReferencePtr();
    
    CReferencePtr(const CReferencePtr<TType>& _rCopy);

	template <typename TType2>
	CReferencePtr(const CReferencePtr<TType2>& _rCopy);

    //! \note Creates a new reference pointer to _pObject and invalidates the original (set to NULL)
	CReferencePtr(TType*& _rpObject);
		
	~CReferencePtr();
	
public:
	
	CB_FORCEINLINE TType& CB_INLINE_ATTR operator * ()						{ return *m_pObject; }
	CB_FORCEINLINE TType* CB_INLINE_ATTR operator -> ()						{ return m_pObject; }
	
    CB_FORCEINLINE const TType& CB_INLINE_ATTR operator * () const			{ return *m_pObject; }
	CB_FORCEINLINE const TType* CB_INLINE_ATTR operator -> () const			{ return m_pObject; }
	
	CB_FORCEINLINE TType* CB_INLINE_ATTR GetObject() const					{ return m_pObject; }
	CB_FORCEINLINE bool CB_INLINE_ATTR IsValid() const						{ return m_pObject != NULL; }
	
	CB_FORCEINLINE int32 CB_INLINE_ATTR GetReferenceCount() const			{ return (m_pReferenceCounter) ? *m_pReferenceCounter : 0; }
	CB_FORCEINLINE const int32* CB_INLINE_ATTR GetReferenceCounter() const	{ return m_pReferenceCounter; }
	
	CB_FORCEINLINE bool CB_INLINE_ATTR IsLastReference() const				{ return (m_pReferenceCounter) ? *m_pReferenceCounter == 1 : false; }
	
public:

	//! \note Creates a new reference pointer to _pObject and invalidates the original (set to NULL)
	CB_FORCEINLINE CReferencePtr& CB_INLINE_ATTR operator = (TType*& _rpNewObject);
	CB_FORCEINLINE CReferencePtr& CB_INLINE_ATTR operator = (const CReferencePtr<TType>& _rCopy);
    
    template <typename TType2>
    CB_FORCEINLINE CReferencePtr& CB_INLINE_ATTR operator = (const CReferencePtr<TType2>& _rCopy);
		
	CB_FORCEINLINE void CB_INLINE_ATTR Release();
	
private:
	
	TType *m_pObject;
	int32 *m_pReferenceCounter;
};

#include "CBL_ReferencePtr.hpp"

CB_NAMESPACE_END

#endif